home *** CD-ROM | disk | FTP | other *** search
/ Aminet 28 / Aminet 28 (1998)(GTI - Schatztruhe)[!][Dec 1998].iso / Aminet / comm / irc / orionbot1.lha / orionbot.doc < prev    next >
Encoding:
Text File  |  1998-09-22  |  12.5 KB  |  439 lines
  1. Short: A fun configureable bot
  2. Author: amiga@ticon.net (Andrew Drays)
  3. uploader: amiga@ticon.net (Andrew Drays)
  4. Version: 1.0
  5. Type: comm/irc
  6. WebPage: http://www.ticon.net/~amiga
  7.  
  8. --------------
  9.  Description: 
  10. --------------
  11.  
  12. Welcome to The world of OrionBOT.. the preceeding work of OrionIRC...
  13.  
  14. OrionBot is a Bot to kind of take care of a channel.. and it not too
  15. complex right now, as it's in it's infancy, but has been growing steadily
  16. from a teeny little program to show how to use TCP, to what it is today.. 
  17.  
  18. Written in BlitzBasic ..
  19.  
  20.  
  21. -----------
  22.  Shareware
  23. -----------
  24.  
  25.     Yes, I'm asking for money.. $5.. and you'll get a personalized version
  26. and all future updates.. 
  27.  
  28. and you'll be making an investment into all my future developments.. 
  29.  
  30. OrionIRC - IRC program with Orionbot built in...
  31.  
  32. OrionIRCDaemon .. IRC server Daemon with OrionBot built in..
  33.  
  34. I will deduct the $5 towards the other programs if your already a
  35. registered OrionBot user.. so they'll be $5 less if your interested..
  36.  
  37. if you use this program regularly,
  38.  
  39. Please send $5 to:
  40.  
  41. Bit Plane Software
  42. c/o Andrew Drays
  43. 2624 King Street
  44. Janesville, WI 
  45.                53546
  46.  
  47.  
  48. --------------
  49.  Requirements
  50. --------------
  51.  
  52. As far as I know,
  53.  
  54. any Amiga running a TCP stack with Miami or AmiTCP equivelant TCP stack
  55. ECS Chipset
  56. "bsdsocket.library"
  57.  
  58. Your memory requirements will rise as more random lines and greetings you
  59. have.. 
  60.  
  61.  
  62. ----------
  63.  Features
  64. ----------
  65.  
  66. Easy to configure
  67. Fast Response
  68. AI - Simple but fun (uses an old ELIZA routine!)
  69. Random Text display
  70. Random Sleep timer
  71. Random Greetings
  72. Multi User Access
  73. Text Encryption
  74.  
  75.  
  76. --------------
  77.  Legal Stuff:
  78. --------------
  79.  
  80.     if you run it.. and it blows up your computer.. it's your problem, not
  81. mine.. I designed it to be a simple bot.. not a virus.. don't bother suing
  82. me for any damages.. 
  83.  
  84. I will attempt to fix any minor problems in my program that may arise from
  85. the use of my program.. 
  86.  
  87.  
  88. --------------
  89.  Installation
  90. --------------
  91.  
  92. It needs the TOSFONTS in the FONTS: dir.. otherwise, all the rest of the
  93. files need to reside in the same directory the program is in..
  94.  
  95. ------------------
  96.  Options & Config
  97. ------------------
  98.  
  99. the bot is pretty self sufficient.. and will run by itself without any
  100. files, but there are some config files you may wish to have setup.. 
  101.  
  102. "bot.cfg"
  103.  
  104. ---- beginning of file .. snip here ..
  105. #OrionBot
  106. newyork.ny.us.undernet.org
  107. OrionToB
  108. This is not me!
  109. greet.cfg
  110. access.cfg
  111. command.menu
  112. onelines.bot
  113. @
  114. 20
  115. 4
  116. 2
  117. ----- end of file .. snip here ..
  118.  
  119. Line# . Explanation
  120. 1. default channel name on login
  121. 2. default server to connect to
  122. 3. Bot's default nickname
  123. 4. your bot's "realname" info.. can be left as blank line
  124. 5. greeting file to use for joining a channel
  125. 6. MultiUser Access File 
  126. 7. your "commands" menu filename config
  127. 8. your random lines text file
  128. 9. your command prefix character (only 1)
  129. 10. How Many lines pass for each random outburst
  130. 11. Text display color
  131. 12. OrionBot test & timer switch
  132.  
  133. ----------------------------------------------------------------------------
  134.  
  135.  
  136. -------------------
  137.  Options in Detail
  138. -------------------
  139.  
  140. 1. When the bot goes into the IRC it needs to be in a channel, so it can be
  141.    useful.. it can go into just about any channel, since the bot uses your
  142.    IP, it can go into any channel you can.. this is granting your not banned
  143.    or anything.. 
  144.  
  145. Default: #testbot
  146.  
  147. ** Future revisions will have a File name and a selectable list that you
  148.    pre-set for the bot to be in, possibly multiple channels..
  149.  
  150. ----
  151. 2. server option goes the same as a channel option, but most Servers notice
  152.    that your IP is on thier server already so try not to have the bot go
  153.    on the same server your IRC program is logged onto already.. I've made
  154.    error traps so the bot will quit if it runs into any problems.. 
  155.  
  156. default: us.undernet.org
  157.  
  158. ----
  159. ** As with the Channel option I plan on having a configureable server file
  160.    that the bot will use for you to quickly select servers, as of now you
  161.    need to edit the cfg file to change them, sorry..
  162.  
  163. ----
  164. 3. Obviously the nickname you choose for your bot.. be careful that you
  165.    choose an ORIGINAL nickname! I have yet to incorporate an error trap for
  166.    a duplicate nick! and some servers will not accept a nickname with "bot"
  167.    anywhere in it..
  168.  
  169. default: OrionBot
  170.  
  171. ----
  172. 4. This is the information displayed in the "/whois" infor for it's
  173.    realname, you can be as creative as you want and as wild for this, or
  174.    you can leave it blank, if you leave the line blank it will simply
  175.    display the Bot's version and owner information
  176.  
  177. default: - realname?!
  178.  
  179. ----
  180. 5. This little diddy is kinda neet.. whenever OrionBot goes into a channel
  181.    it'll pop up a random greeting from whatever file you designate, 
  182.    granting it's less then 80 characters.. the file limit is 100 lines.. 
  183.  
  184. default: greet.cfg
  185.  
  186. ----
  187. 6. This is the file that is a relief to many of my beta testers, and a
  188.    godsend to myself, also.. the multiuser access file.. it contains 3
  189.    simple lines.. 
  190.  
  191.    Nick 1          . whatever your nick is
  192.    password 1      . your password
  193.    access 2        . anything from 10 to 99 .. it don't care
  194.    nick 2          . a friends nick
  195.    password 2      . his password
  196.    access 2        . his access below 10?
  197.    nick 3
  198.    etc..
  199.  
  200.    each line set up in a way so that more then one person can access the
  201.    bot and it's abilities..the people you give access to your bot know to
  202.    off "offme" thier access when thier done for the day so other people
  203.    don't log on with thier nick and use thier access.. 
  204.  
  205.    access levels are hard coded as of this version.. maybe later it'll be
  206.    different.. level 1 to 99.. as shown in the commands menu.. 
  207.  
  208. ** Future Versions will contain IP security .. 
  209.  
  210. default: access.cfg
  211.  
  212. ----
  213. 7. you might wanna leave this file alone.. it can have upto 50 lines of text
  214.    80 characters wide... and have it display any way you wish.. never
  215.    versions will have configureable access levels per command so to keep
  216.    yourself from haveing to re-write thsi file later.. just leave it be.. 
  217.    the longer you make it the longer it takes to display..
  218.  
  219. ** I built a display delay timer into OrionBot to keep it from flooding
  220.    out.. although it can display 50 lines.. I suggest you keep it to
  221.    under 20.. I may lower this in the future anyways..
  222.  
  223. default: command.menu
  224.  
  225. ----
  226. 8. this is the file name that you use for the bot to spit out random
  227.    text.. one liners basicly.. I use an old taglines file, myself..
  228.    the file line limit is 5000 lines.. granting you have enough memory for
  229.    THAT many lines.. 
  230.  
  231. default: oneline.bot
  232.  
  233. ----
  234. 9. your command prefix character.. the program will only read 1 character
  235.    from this line so you can't have multiple command headers.. I.e. $% or
  236.    anything like that, sorry.. 
  237.  
  238. default: -
  239.  
  240. ----
  241. 10. This defines how many line go by in the IRC, that the BOT sees that
  242.     someone with an IP said something, before it splurts out some nonsense
  243.     from it's oneline file.. if you want to turn this option off just put
  244.     a "-1" in this line.. and it won't blurb anything out, but the "random"
  245.     option will still be active.. 
  246.  
  247. default: 20
  248.  
  249. ----
  250. 11.?This is the option to choose what color your text will display at.. use
  251.     the *test mode* to have a display of all the colors available..
  252.  
  253. default: 2
  254.  
  255. ----
  256. 12. This is an actual Switch that controls 2 functions.. testmode and
  257.     random sleep timer.. it will accept one of three numbers for it's
  258.     arguments.. if it's not one of the three numbers.. it defaults to 0..
  259.  
  260.     0 turns off sleep timer and test mode
  261.     1 turns on test mode
  262.     2 turns on sleep timer
  263.  
  264.     0 is self explanitory after 1 and 2 are explained
  265.  
  266.     1 this is a test mode for the bot, you need not run your TCP stack to
  267.       use this option, as it doesn't access IRC when this is on.. 
  268.  
  269.       Test mode is something I made for myself, but I figure it might come
  270.       in handy for other people to use if they're encountering a problem
  271.       with orionbot..  it access all the data files on the system, and
  272.       displays what is in them, prompting the for use input on each file
  273.       for verbosity.. you may not want it to display all 200+ lines of your
  274.       random file.. so you can see where potential errors may be on why
  275.       OrionBot is messing up for bug reports.. 
  276.  
  277.       it also diplays all the colors to oyu can pick which color you want
  278.       displayed in option #13..
  279.  
  280.     2 if there's no activity in a channel for about 30 seconds the bot will
  281.       pipe up with "random".. maybe to spark someone to talk about the
  282.       funny line that came up and get conversation going.. thus waking up
  283.       "sleepers".. 
  284.  
  285.  
  286. ---------------
  287.  Command Menu:
  288. ---------------
  289.  
  290. * future options? (only with support!)
  291.  
  292. - Level 99 - bye, raw, goto, *set, say, ncrypt
  293.  
  294. - Level 10 - *addnick, *remnick, op, dop, opme, kick
  295.  
  296. - Level 1 - say, *tryme, offme
  297.  
  298. - None - version, VERSION, random, users, commands, pass
  299.  
  300. raw          . Send raw data to the server <only if you KNOW>
  301. bye          . quit the bot via IRC
  302. set          * change a certain setting on the bot
  303. addnick      * add a person to the access list
  304. remnick      * remove a person form the access list
  305. say          . say something to the channel it's in.. 
  306. goto         . go to a channel
  307. opme         . if the bot is an op.. to have it op you
  308. op <nick>    . " .. to have it op <nick>
  309. dop <nick>   . " .. have it deop <nick>
  310. ncrypt <?>   . have it encrypt text (don't do it if it annoys others)
  311. commands     . menu of available commands
  312. owner <nick> . transfer ownership fo the bot so someone else
  313. random       . do a random oneliner
  314. pass <pass>  . turn on bot access if your on the user list via password 
  315. offme        . turn off your access
  316. tryme        * random oneliner to person then random kick choice
  317.  
  318. I wouldn't suggest using this bot as a channel monitor quite yet.. it COULD
  319. be used as one but, it has flaws..
  320.  
  321. at current it only uses a nickname as an identifier.. if someone has
  322. your nickname, and password they can access it.. or if you leave the
  323. channel, or ping out of a channel, your access is still acitvated, a person
  324. could easily take over your channel.. it doesn't have a routine to
  325. deactivate a person leaving a channel yet.. my to do list is pretty
  326. extensive, with security procedures at the top.. this is meant as a bot
  327. for fun...
  328.  
  329. Enjoy!
  330.  
  331.  
  332. -----
  333.  GUI
  334. -----
  335.  
  336. The Gui For the Bot isn't very complex... for futue concepts and ideas, the
  337. bot opens on it's own 16 color screen.. there's a 3 options in the pull
  338. down menu.. CLI, ABOUT, and QUIT.. all I think are self explanitory and
  339. easy to use.. 
  340.  
  341.  
  342. --------
  343.  Future
  344. --------
  345.  
  346. As Stealth put it.. "Frills" ... Games like Trivia.. maybe tic tac toe.. ..
  347. whatever I can find in a "basic" that's text based for me to convert.. 
  348.  
  349.  
  350. ------------------------------------
  351.  Problems and Bug Reports and IDEAS
  352. ------------------------------------
  353.  
  354. Simply E-mail me with the problem.. but before ya go doing that, be sure to
  355. take a look at the "Bot.log" on your system.. it will have a detailed list
  356. of server to bot activity.. 
  357.  
  358. be sure to send this file with the bot problem information...
  359.  
  360.  
  361. --------
  362.  Thanks
  363. --------
  364.  
  365. Many Special thanx to my good Friends in #amirc!
  366. (Listed in Alphabetical order)
  367. Cav
  368. Funkman (beta Tester)
  369. Grog
  370. Stealth (beta tester)
  371. Zonkerz
  372.  
  373. People from Blitz list!
  374.  
  375. Paul Burkey for the code to work from...
  376.  
  377.  
  378. ----------------------
  379.  Progress & Versions:
  380. ----------------------
  381.  
  382. I feel confident that I have a higher level bot with complete
  383. functionality and working comfortable setup, it is Version 1.0.. 
  384.  
  385. my ultimate goal is to turn this BOT into an IRC program with a
  386. full featured bot built in.. 
  387.  
  388. you can keep up on my progress and versions and log on my webpage..
  389. (if I ever update it!)
  390.  
  391. V.01 to V.06b
  392.  
  393. a simple bot not TOO far from the original bot I started 
  394. with.. added configurability, and a few functions.. and instead of using
  395. the "/" I made it use "-" .. added VERSION, -op & -say .. fixed a bug on
  396. PING timeouts and server errors.. added verbosity on, config loading and
  397. server connections..
  398.  
  399. V.07 
  400.  
  401. added -owner 
  402.  
  403. V.10
  404.  
  405. Added -ncrypt and -commands
  406.  
  407. V.10a
  408.  
  409. used a new version of TCPfuncts for optimized and fixed TCP functions..
  410.  
  411. v.11
  412.  
  413. Made GUI and windows.. to quit if a person lost a server.. 
  414. Can now be launched from workbench!
  415.  
  416. V.12 
  417.  
  418. Fixed a bug that made it so it would wait for an intuition event before it
  419. would do anything..
  420.  
  421. V1.0 
  422.  
  423. Kick ass intro.. I stole the code from an example.. but it works.. ;)
  424. "About" Bug Fixed!
  425. On 16 color Screen
  426. Encryption fixed
  427. password option fixed (DAMN! figures! just in time to take it out!!)
  428. randomized all over
  429. etc.. etc.. etc..
  430.  
  431. -------------
  432.  Known Bugs!
  433. -------------
  434.  
  435. - 40 character cutoff bug!?!
  436.  
  437. ----------------------------------------------------------
  438. EOF
  439.